home *** CD-ROM | disk | FTP | other *** search
/ MACD 5 / MACD 5.bin / workbench / tools / czesc_1 / chooser / chooser.doc < prev    next >
Text File  |  1995-01-12  |  12KB  |  393 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.                                Chooser.guide
  7.  
  8.  
  9.                                   Version
  10.                         Chooser.guide 1.0 (13.1.95)
  11.  
  12.  
  13.  
  14.  
  15.                                 Simon Dick
  16.  
  17.  
  18.  
  19.                         © 1995 Simon Dick, Mailware
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.                         Generated with Heddley v1.1
  37.                      Heddley v1.1 (C) Edd Dumbill 1994
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.  
  71.  
  72.  
  73.  
  74.  
  75.  
  76.                                 - Page 1 -
  77.  
  78.  
  79.  
  80. 1.    Chooser
  81.  
  82.  
  83.                              Chooser V1.0
  84.  
  85.                           © 1995 Simon Dick
  86.  
  87.         Introduction                   System Requirements
  88.         Installation                   Usage from the Shell
  89.         Usage from Workbench           File Format
  90.         History                        Future
  91.         Copyright                      Author
  92.  
  93. 2.    Introduction
  94.  
  95. Chooser was written to be a replacement for Nico François' menu program,
  96. Selector. This is because Selector didn't adapt to screens which didn't use
  97. the topaz 8 font. This meant that it didn't look that good when run on a
  98. lot of peoples Workbench screens.
  99.  
  100. Another problem with Selector was that it couldn't be run from the
  101. Workbench, only from the CLI which made it a bit awkward to use if you want
  102. to use it on a non autobooting disk. This would mean that you would have to
  103. write a script using IconX or some equivalent to run it.
  104.  
  105. 3.    Requirements
  106.  
  107. Chooser needs the reqtools.library (V38 or higher) installed in order to
  108. run. If you want to be able to run Chooser under Workbench 1.3 then you
  109. need gadtools.library V34 installed (supplied).
  110.  
  111. 4.    Installation
  112.  
  113. Workbench 2+
  114.  
  115. All you need to do to install Chooser under Workbench 2+ is copy the file
  116. libs/reqtools.library to your LIBS: directory and then put Chooser wherever
  117. you want to keep it.
  118.  
  119. Workbench 1.3
  120.  
  121. Under Workbench 1.3 you need to copy both the libraries in the libs13
  122. drawer to your LIBS: directory. The reqtools.library is the 1.3 compatible
  123. version and the gadtools.library is a 1.3 compatible version of the
  124. gadtools.library which is built into the Kickstart 2+ ROM, it was written
  125. by Massimo Tantignone. Then you can put Chooser wherever you want to keep
  126. it. Although this version of Chooser runs under Workbench 1.3, there is the
  127. obvious drawback of needing the 50k gadtools.library installed, also I
  128. can't guarantee that future versions of Chooser will be able to use every
  129. feature under Workbench 1.3. Also Nico François has stopped development of
  130. the Workbench 1.3 compatible version of reqtools.library.
  131.  
  132. 5.    Usage from the Shell
  133.  
  134. Chooser can be used from the Shell, here is a list of the different
  135. commands that it accepts:
  136.  
  137. FILE
  138.  
  139. This tells Chooser what menu file to load and use, if you don't specify it,
  140. Chooser will try to read a file called 'S:Chooser.programs'.
  141.  
  142. -H=EVENUP/S
  143.  
  144. This tells Chooser to try to even up the lengths of the two columns. It has
  145. no effect if all of the gadgets are in a single column. For those of you
  146.  
  147.                                 - Page 2 -
  148. 5.    Usage from the Shell
  149.  
  150. who have previously used Nico François' Selector then you can also use the
  151. -h option instead of using EVENUP (they are both exactly the same). But if
  152. you are running Chooser under Workbench 1.3, only the -h argument will be
  153. recognised, the EVENUP argument will not be. But the -h argument works
  154. under Workbench 1.3 and 2+.
  155.  
  156. Chooser can also be made resident.
  157.  
  158. 6.    Usage from Workbench
  159.  
  160. This is probably the way quite a few people will use Chooser. You can use
  161. Chooser from the Workbench in a number of different ways, here they are:
  162.  
  163.    You can just double click on Choosers icon, Chooser then looks for a
  164. menu file called S:Chooser.programs. If you include the USETHISDISK
  165. tooltype then Chooser won't look for S:Chooser.programs, but
  166. :S/Chooser.programs instead.
  167.  
  168.    You can give your menu file a project icon and set Chooser as its
  169. default tool.
  170.  
  171. Here is a list of the tooltypes that Chooser supports:
  172.  
  173. EVENUP
  174.  
  175. If this tooltype is present and all of the buttons won't fit in a single
  176. column then two columns will be used (as usual) but instead of being very
  177. uneven
  178.  
  179. FILE
  180.  
  181. Using this tooltype you can tell Chooser what file to try to load, if you
  182. add a tooltype saying FILE=Work:AMenuFile, Chooser will try to load a menu
  183. file called Work:AMenuFile. This tooltype is only checked for when you run
  184. Chooser without any arguments and is checked for before the USETHISDISK
  185. tooltype.
  186.  
  187. USETHISDISK
  188.  
  189. This tooltype is only checked for if you run Chooser without any arguments.
  190. It causes Chooser to change the file that it looks for as the default.
  191. Usually the menu file that Chooser looks for is called S:Chooser.programs,
  192. but if you use this tooltype Chooser will look for a menu file called
  193. :S/Chooser.programs.
  194.  
  195. NOTE ABOUT TOOLTYPES UNDER WORKBENCH 1.3!
  196.  
  197. Under Workbench 1.3, you need to have an equals sign after a tooltypes name
  198. for it to be recognised, you don't under Workbench 2+ (but it still works
  199. with an equals sign as well) so if you want your tooltypes to work under
  200. both, just include an equals sign after the tooltypes.
  201.  
  202. 7.    Menu File Format
  203.  
  204. Chooser will read a script and interpret in this way:
  205.  
  206.   line    | description                        |  example          |
  207. ----------+------------------------------------+-------------------+
  208.     1     | Window title                       |  Utilities Disk   |
  209.     2     | text for 1st gadget (max 79 char)  |  EdWord Pro V5.0  |
  210.     3     | command sequence (max 256 char)    |  *Work:EdWordPro  |
  211.     4     | text for 2nd gadget                |  Heddley          |
  212.     5     | 2nd command sequence               |  *Work:Heddley    |
  213.     .     | ...                                |  .....            |
  214.  
  215.     The command sequence consists of any number of commands seperated by
  216. ';'. The following characters all have a special meaning, use them as the
  217.  
  218.                                 - Page 3 -
  219. 7.    Menu File Format
  220.  
  221. first character of a command:
  222.  
  223.  '*' : Put a '*' in front of the MAIN program if you want to multitask. If
  224. you don't want to be able to multitask a program don't put a '*' in front
  225. of the main program. (see RUN mode)
  226.  
  227.  '#' : When there is a '#' in front of a program it will allways be
  228. launched, even in EXEC or RUN mode. This is mainly useful for programs
  229. which need as much memory as possible or don't return to the CLI.
  230.  
  231.  '!' : The prompt command. The string following the '!' isn't a command but
  232. instead is a prompt. A string gadget will appear and prompt you for the
  233. arguments to be passed to the next command. The '!' must be the command
  234. directly in front of the command you want the parameters to be passed to.
  235. One word of warning, if you are typing a filename which has spaces in it
  236. into the prompt requester, please put quotes around it otherwise it will
  237. not work.
  238.  
  239.  '<' : Read new file list. The selector will read the file directly
  240. following the '<' and will use this to display a new file list. This is
  241. useful to implement sub-menus.
  242.  
  243.  '@' : If you want to use a subtitle enter a '@' instead of the command
  244. sequence, the text will appear as a subtitle and can't be selected.
  245.  
  246. NOTE : - Include the path to avoid problems, e.g. 'Disk1:Program' instead
  247.          of 'Program'.  Be careful when you use spaces !
  248.  
  249.     Example script:
  250.  
  251.         UTILITIES
  252.         This program is the editor
  253.         !Edit what file ? ;*c:MicroEMACS
  254.         This is a subtitle
  255.         @
  256.         This program doesn't work with fast memory
  257.         c:Run SYS:System/NoFastMem;*:ProgramName
  258.  
  259. The number of gadgets that will appear in Choosers window is dependant on
  260. how large the users Workbench screen and default font is.
  261.  
  262. 8.    History
  263.  
  264. Chooser v1.0 (13 January 1995) 18888 bytes
  265.   Initial release
  266.  
  267. 9.    Future
  268.  
  269. Possible future improvements to Chooser
  270.    Allow Chooser to have more than two columns of gadgets.
  271.    Have multiple menus open on the screen at once.
  272.  
  273. Suggestions please.
  274.  
  275. 10.    Copyright
  276.  
  277. Chooser is © 1995 Simon Dick
  278.  
  279. This software is subject to the "Standard Amiga FD-Software Copyright Note"
  280. It is Mailware as defined in paragraph 4b. For more information please read
  281. "AFD-COPYRIGHT" (Version 1 or higher).
  282.  
  283. Thanks to various members of Amigaholics International for their
  284. suggestions. If you want more information about them, contact Kevin Bryan
  285. at:
  286.                 Amigaholics Club
  287.                 49 Coutts House,
  288.  
  289.                                 - Page 4 -
  290. 10.    Copyright
  291.  
  292.                 Charlton Church Lane,
  293.                 Charlton,
  294.                 London.
  295.                 SE7 7AS.
  296.                 England
  297.  
  298.  - reqtools.library is Copyright (c) Nico François.
  299.  - gadtools.library v34 is Copyright (c) Massimo Tantignone.
  300.  - Thanks to the authors of the AFD-Copyright text file!
  301.  - Thanks to Nico François for writing Selector in the first place.
  302.  
  303. 11.    Author
  304.  
  305. Chooser was written by:
  306.     Simon Dick
  307.  
  308. My address is:
  309.     31 Salisbury Road
  310.     Bexley
  311.     Kent DA5 3QE
  312.     England
  313.  
  314. or until the end of June 1995 during term time:
  315.     Avon Way House 2.3/B
  316.     Avon Way
  317.     Colchester CO4 3TZ
  318.     England
  319.  
  320. My Email address is currently:
  321.     sidick@essex.ac.uk
  322.  
  323. Chooser was developed on an A1200 with 4MB of RAM, a 20MHz 68882, with an
  324. 80MB hard drive, running Workbench 3.0. Chooser was compiled using DICE
  325. V3.0. The Chooser documentation was written using the Heddley AmigaGuide
  326. authoring system.
  327.  
  328. If you have any suggestions, bug reports, questions, spare money, etc. then
  329. feel free to write to me. I will do my best to reply as long as you supply
  330. return postage (preferably IRC's unless you're in the UK).
  331.  
  332.  
  333.  
  334.  
  335.  
  336.  
  337.  
  338.  
  339.  
  340.  
  341.  
  342.  
  343.  
  344.  
  345.  
  346.  
  347.  
  348.  
  349.  
  350.  
  351.  
  352.  
  353.  
  354.  
  355.  
  356.  
  357.  
  358.  
  359.  
  360.                                 - Page 5 -
  361. 11.    Author
  362.  
  363.  
  364. 12.    INDEX of sections
  365.  
  366. Author ..........................................................   4. 10
  367. Chooser .........................................................   1.  0
  368. Copyright .......................................................   3. 53
  369. Future ..........................................................   3. 45
  370. History .........................................................   3. 40
  371. Installation ....................................................   1. 31
  372. Introduction ....................................................   1. 13
  373. Menu File Format ................................................   2. 51
  374. Requirements ....................................................   1. 25
  375. Usage from the Shell ............................................   1. 52
  376. Usage from Workbench ............................................   2.  7
  377.  
  378. 13.    INDEX of keywords
  379.  
  380. AFD-COPYRIGHT ...................................................   3. 60
  381. Author ..........................................................   1. 12
  382. Copyright .......................................................   1. 12
  383. File Format .....................................................   1. 10
  384. Future ..........................................................   1. 11
  385. gadtools.library ................................................   1. 30
  386. History .........................................................   1. 11
  387. Installation ....................................................   1.  9
  388. Introduction ....................................................   1.  8
  389. reqtools.library ................................................   1. 28
  390. System Requirements .............................................   1.  8
  391. Usage from the Shell ............................................   1.  9
  392. Usage from Workbench ............................................   1. 10
  393.